Get Request Status V2

This API is used to query the system for a previously sent request and get its status, Succeeded, Failed or Still In Progress.

HTTP URL
GET	/api/v2/global/call/{id}

{id} is the UUID (requestId) that was provided in the asynchronous response.

Eligibility

The Requester is eligible to request, for API calls, status for own generated request IDs.

API Request

Request Structure

This API has no request structure.

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content Data Objects

Parameter	Type	M/O/CM	Description
status	String	M	Status of the API call. Valid values: OPEN, SUCCESS, FAILURE, INTERNAL_ERROR.

Pageable Data Objects

Parameter	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
GLOBAL_1003	Provided request ID does not exist for your account.

Examples

Request Body

Copy

{
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "status": "OPEN"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "GLOBAL_1003",
  "errorMessage": "Provided request ID does not exist for your account",
  "content": "",
  "pageable": ""null
}